Skip to content

Rename report to examples_compatibility_report.html#942

Merged
KayMKM merged 2 commits into
gh-pagesfrom
yuesu/update_report
Jun 24, 2026
Merged

Rename report to examples_compatibility_report.html#942
KayMKM merged 2 commits into
gh-pagesfrom
yuesu/update_report

Conversation

@KayMKM

@KayMKM KayMKM commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@DingmaomaoBJTU DingmaomaoBJTU left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this rename is clean and consistent across all touched files. Three minor issues to note:

  1. Module docstring not updated (download_report.py line 5): The top-level docstring still reads 'Fetch the model compatibility report' — it was not updated in this PR while every other reference was.

  2. Link text vs. filename/page title mismatch (dev/reference/supported-models/index.html): The visible link text was changed to 'models accuracy report' but the target filename contains 'examples_compatibility' and the HTML title/h1 reads 'Model Accuracy Report'. Consider aligning these three strings.

  3. Deployment coordination: SOURCE_FILE in download_report.py now points to 'e2e_model_coverage_result/examples_compatibility_report.html' in the private gim-home/ModelKitArtifacts repo. The download script will fail until that repo is updated to generate the new filename — worth confirming this is coordinated.

  4. HTML title mismatch (examples_compatibility_report.html line 6): The HTML title tag reads 'Model Accuracy Report' while the filename is examples_compatibility_report.html. If the title is intentional (emphasising accuracy), the filename should match; if the filename is dictated by the private repo generator, the title should align to it.

Comment thread dev/reference/supported-models/index.html Outdated
Comment thread reports/download_report.py Outdated
… naming

- Fix module docstring in download_report.py (was still 'model compatibility report')
- Standardize display name to 'Model Accuracy Report' across docstring, README, argparse, and docs link to match the report page title
- Update SOURCE_FILE and all references to model_accuracy_report.html
- Update dev search index entry for consistency

@DingmaomaoBJTU DingmaomaoBJTU left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All four issues from the previous review are addressed in the follow-up commit:

  • Link text/URL/title alignment ✅ — link now reads 'Model Accuracy Report' pointing to \model_accuracy_report.html, matching the page <title>.
  • Module docstring ✅ — updated to 'Fetch the model accuracy report from gim-home/ModelKitArtifacts.'
  • SOURCE_FILE / deployment coordination ✅ — now targets \model_accuracy_report.html; README and docstring are consistent. The private repo coordination concern is an ops matter, not a code defect.
  • HTML <title>\ vs filename mismatch ✅ — file renamed to \model_accuracy_report.html, matching the embedded title.

The rename is clean, consistent, and correct across all touched files. Approving.

@KayMKM KayMKM merged commit e2c32d5 into gh-pages Jun 24, 2026
1 check passed
@KayMKM KayMKM deleted the yuesu/update_report branch June 24, 2026 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants